refactor: rename status#217
Merged
Merged
Conversation
github-actions
Bot
added
documentation
Contributor
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified Files
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR standardizes the terminology for sanity check outcomes by replacing "SUCCESS/FAILURE" with "PASSED/FAILED" throughout the codebase and documentation. The changes improve consistency and clarity while simplifying the summary output format.
Key Changes:
- Renamed
Statusenum values and updated all related methods (is_success→is_passed,is_failure→is_failed) - Simplified the summary table output by removing redundant columns and updating column names
- Updated documentation to reflect the new terminology and table format
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| t4_devkit/sanity/result.py | Renamed Status enum values, updated method names and docstrings, simplified summary table output |
| t4_devkit/cli/sanity.py | Updated CLI exit condition to use new is_passed method |
| docs/cli/t4sanity.md | Updated documentation with new summary table format and JSON status values |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ktro2828
force-pushed
the
refactor/sanity/status
branch
from
3f175a5 to
27a4a66
Compare
shekharhimanshu
approved these changes
Nov 14, 2025
shekharhimanshu
left a comment
shekharhimanshu
left a comment
Contributor
There was a problem hiding this comment.
LGTM. Thank you! 💯
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
ktro2828
force-pushed
the
refactor/sanity/status
branch
from
27a4a66 to
7dfbebb
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
This pull request standardizes the terminology used for reporting rule outcomes in the sanity checking module, changing from "SUCCESS/FAILURE" to "PASSED/FAILED". It updates both the codebase and documentation to reflect this new terminology, and simplifies the printed summary output. The changes improve clarity and consistency across the code, output, and documentation.
Terminology and Status Standardization
Status.SUCCESS/Status.FAILUREtoStatus.PASSED/Status.FAILEDint4_devkit/sanity/result.py, and updated all related logic, methods, and assertions to use the new terms (is_success→is_passed,is_failure→is_failed, etc.). [1] [2] [3] [4] [5]t4_devkit/cli/sanity.pyto useis_passedinstead ofis_success.Summary Output and Documentation Updates
t4_devkit/sanity/result.pyto use the new "Passed", "Failed", "Skipped", and "Warnings" columns, removing the old "Status", "Rules", and "Success/Failures/Skips" columns.docs/cli/t4sanity.mdto show the new summary table format and changed the status values in the JSON output example from "SUCCESS/FAILURE" to "PASSED/FAILED". [1] [2]